home *** CD-ROM | disk | FTP | other *** search
/ IBM InfoROM for OS/2 Beta 1995 January / IBM InfoROM for OS2 Beta 1-1995.ISO / testcert / mmedia / system / ap2 / ap2.hlp (.txt) < prev    next >
Encoding:
OS/2 Help File  |  1994-08-26  |  16.2 KB  |  455 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Introduction ΓòÉΓòÉΓòÉ
  3.  
  4. AP2 automates the testing of audio device drivers using P2String. It first 
  5. tests the default device driver's capabilities (if the option is checked) and 
  6. then displays a list of test cases that the device supports. You can select 
  7. several test cases to run. At the end of each test case, AP2 displays the 
  8. status of that test case (success or failure). 
  9.  
  10. This Help file is composed of the following sections: 
  11.  
  12. o  Introduction 
  13. o  How to use AP2 
  14. o  Data Structure 
  15. o  Test Case Output 
  16. o  The Description File 
  17. o  Error Messages 
  18. o  P2String 
  19. o  CDXA 
  20.  
  21.  
  22. ΓòÉΓòÉΓòÉ 2. How to use AP2 ΓòÉΓòÉΓòÉ
  23.  
  24. o  Command Line Arguments 
  25. o  Testing 
  26. o  Device Capabilities 
  27. o  The Stop Button 
  28. o  The View Output Button 
  29. o  The DataPath Button 
  30.  
  31.  
  32. ΓòÉΓòÉΓòÉ 2.1. Command Line Arguments ΓòÉΓòÉΓòÉ
  33.  
  34. When running AP2, it can be invoked by simply typing AP2, or by using any of 
  35. the following arguments: 
  36.  
  37. o  SCRIPTS 
  38. o  /ALL 
  39. o  /AMPMIX 
  40. o  /CD 
  41. o  /CDXA 
  42. o  /MIDI 
  43. o  /VIDEO 
  44. o  /WAVE 
  45. o  /INTERACTIVE 
  46. o  /BATCH 
  47. o  /TEST 
  48. o  /NOTEST 
  49. o  /DATAPATH 
  50. o  /O 
  51.  
  52.  
  53. ΓòÉΓòÉΓòÉ 2.1.1. SCRIPTS ΓòÉΓòÉΓòÉ
  54.  
  55. Specifying The SCRIPTS Parameter will load into AP2 All scripts that match the 
  56. filename given for SCRIPTS.  Wildcards "*" and "?" are supported. 
  57.  
  58. If no switches are used to designate which files are to be selected, then all 
  59. the loaded SCRIPTS will be selected.  Otherwise, only those scripts matching 
  60. the selection switches will be highlighted. 
  61.  
  62.  
  63. ΓòÉΓòÉΓòÉ 2.1.2. /ALL ΓòÉΓòÉΓòÉ
  64.  
  65. Specifying The /ALL Switch will select ALL scripts that are displayed. If the 
  66. /BATCH switch is used in conjunction with /ALL, the selected scripts will be 
  67. tested. 
  68.  
  69.  
  70. ΓòÉΓòÉΓòÉ 2.1.3. /AMPMIX ΓòÉΓòÉΓòÉ
  71.  
  72. Specifying The /AMPMIX Switch will select all AMPMIX scripts that are 
  73. displayed. If the /BATCH switch is used in conjunction with /AMPMIX, the 
  74. selected scripts will be tested. 
  75.  
  76. AMPMIX scripts are identified by the first letter of the filename beginning 
  77. with "A". 
  78.  
  79.  
  80. ΓòÉΓòÉΓòÉ 2.1.4. /CD ΓòÉΓòÉΓòÉ
  81.  
  82. Specifying The /CD Switch will select all CD scripts that are displayed. If the 
  83. /BATCH switch is used in conjunction with /CD, the selected scripts will be 
  84. tested. 
  85.  
  86. CD scripts are identified by the first letter of the filename beginning with 
  87. "C". 
  88.  
  89.  
  90. ΓòÉΓòÉΓòÉ 2.1.5. /CDXA ΓòÉΓòÉΓòÉ
  91.  
  92. Specifying The /CDXA Switch will select all CDXA scripts that are displayed. If 
  93. the /BATCH switch is used in conjunction with /CDXA, the selected scripts will 
  94. be tested. 
  95.  
  96. CDXA scripts are identified by the first letter of the filename beginning with 
  97. "X". 
  98.  
  99.  
  100. ΓòÉΓòÉΓòÉ 2.1.6. /MIDI ΓòÉΓòÉΓòÉ
  101.  
  102. Specifying The /MIDI Switch will select all MIDI scripts that are displayed. If 
  103. the /BATCH switch is used in conjunction with /MIDI, the selected scripts will 
  104. be tested. 
  105.  
  106. MIDI scripts are identified by the first letter of the filename beginning with 
  107. "M". 
  108.  
  109.  
  110. ΓòÉΓòÉΓòÉ 2.1.7. /VIDEO ΓòÉΓòÉΓòÉ
  111.  
  112. Specifying The /VIDEO Switch will select all VIDEO scripts that are displayed. 
  113. If the /BATCH switch is used in conjunction with /VIDEO, the selected scripts 
  114. will be tested. 
  115.  
  116. VIDEO scripts are identified by the first letter of the filename beginning with 
  117. "V". 
  118.  
  119.  
  120. ΓòÉΓòÉΓòÉ 2.1.8. /WAVE ΓòÉΓòÉΓòÉ
  121.  
  122. Specifying The /WAVE Switch will select all WAVE scripts that are displayed. If 
  123. the /BATCH switch is used in conjunction with /WAVE, the selected scripts will 
  124. be tested. 
  125.  
  126. WAVE scripts are identified by the first letter of the filename beginning with 
  127. "W". 
  128.  
  129.  
  130. ΓòÉΓòÉΓòÉ 2.1.9. /INTERACTIVE ΓòÉΓòÉΓòÉ
  131.  
  132. Specifying The /INTERACTIVE Switch will select all INTERACTIVE scripts that are 
  133. displayed. If the /BATCH switch is used in conjunction with /INTERACTIVE, then 
  134. the Interactive switch will be ignored. 
  135.  
  136. A file is designated as Interactive if the seventh character in its filename is 
  137. an "I". For example: C1____I1.P2S.  A file should be designated as interactive 
  138. if it uses the @BREAK or the @CHECK P2String Directive. 
  139.  
  140.  
  141. ΓòÉΓòÉΓòÉ 2.1.10. /BATCH ΓòÉΓòÉΓòÉ
  142.  
  143. Specifying the /BATCH switch will run AP2 in a Batch Mode.  When running AP2 
  144. batch, no user interaction is required, nor is it necessary.  The program will 
  145. run, test all scripts, and automatically terminate when there is an error, or 
  146. when all scripts have been tested. 
  147.  
  148. To run in Batch mode, it is required to specify which scripts are to be tested. 
  149. Use any combination of the previous seven switches.  Specifying /VIDEO /WAVE 
  150. /BATCH will automatically test all video and wave scripts and terminate when 
  151. done.  Note: If none of the selection switches are specified, AP2 will return 
  152. an error message specifying that no test cases were selected. 
  153.  
  154. All errors and failed scripts are logged to an OUTPUT file.  The output file 
  155. can be specified with the /O switch. If no output file is specified, AP2.OUT 
  156. will be the default. 
  157.  
  158. In Batch Mode, testing Device Capabilities is defaulted to on, unless the 
  159. /NOTEST switch is specified. 
  160.  
  161. During Batch execution, only those files not designated by their naming 
  162. convention as INTERACTIVE are run.  A file is designated as interactive if the 
  163. seventh character in its filename is an "I".  For example: C1____I1.P2S.  A 
  164. file should be designated as interactive if it uses the @BREAK or the @CHECK 
  165. P2String Directive. 
  166.  
  167.  
  168. ΓòÉΓòÉΓòÉ 2.1.11. /TEST ΓòÉΓòÉΓòÉ
  169.  
  170. Specifying the /TEST switch will automatically test Device Capabilities at 
  171. startup. This setting will also be saved.  The next time AP2 is run, AP2 will 
  172. test the capabilities, unless this option is turned off. 
  173.  
  174.  
  175. ΓòÉΓòÉΓòÉ 2.1.12. /NOTEST ΓòÉΓòÉΓòÉ
  176.  
  177. Specifying the /NOTEST switch will turn off automatically testing Device 
  178. Capabilities at startup. This setting will also be saved.  The next time AP2 is 
  179. run, AP2 will not test the capabilities, unless this option is turned on. 
  180.  
  181.  
  182. ΓòÉΓòÉΓòÉ 2.1.13. /DATAPATH ΓòÉΓòÉΓòÉ
  183.  
  184. The /DATAPATH switch is used to specify the directory used for the datafiles. 
  185. Specifying the DataPath switch is the same as pressing the DataPath button. 
  186.  
  187. To set the DataPath to "C:\DATA" use the following switch: 
  188.  
  189. /DATAPATH=C:\DATA 
  190.  
  191.  
  192. ΓòÉΓòÉΓòÉ 2.1.14. /O ΓòÉΓòÉΓòÉ
  193.  
  194. The /O switch is used to specify an OUTPUT FILE file for AP2.  The output file 
  195. will contain the output generated from all P2String scripts that FAIL.  The 
  196. output file will also report the number of scripts that SUCCEEDED and FAILED. 
  197. When running in BATCH Mode, all errors will also be logged to this file. 
  198.  
  199. To set the Output File to "MYTEST.OUT" use the following switch: 
  200.  
  201. /OMYTEST.OUT 
  202.  
  203. Note: There is no spaces between the /O and the filename. 
  204.  
  205.  
  206. ΓòÉΓòÉΓòÉ 2.2. Testing ΓòÉΓòÉΓòÉ
  207.  
  208. You can select several test cases.  You can also use the All or the None button 
  209. to select all or none of the test cases, respectively. 
  210.  
  211. Press the Start Test button to start running the test cases you selected.  As 
  212. each test case terminates, the result of the test is displayed in the list box 
  213. (success or failure). 
  214.  
  215.  
  216. ΓòÉΓòÉΓòÉ 2.3. Device Capabilities ΓòÉΓòÉΓòÉ
  217.  
  218. AP2 starts by testing the audio device driver's capabilities.  According to the 
  219. outcome of the device capability testing, only the supported test cases will be 
  220. displayed.  If you are familiar with P2String, you can view the file 
  221. CAPABLTY.TXT, which lists the outcome of the device capability testing. 
  222.  
  223. You can disable device capability testing by unchecking the appropriate check 
  224. box in the main window.  In that case, all test cases will be displayed, 
  225. regardless of whether the device supports their functions or not. 
  226.  
  227. Capabilities tested include: 
  228.  
  229. Wave Audio 
  230.  
  231.    o Record 
  232.    o Save 
  233.    o Set the volume 
  234.    o PCM: (8 or 16 bits per sample -- 11k,22k, or 44k samples per second -- 
  235.      mono or stereo -- play or record) 
  236.    o ADPCM: (16 bits per sample -- 11k,22k, or 44k samples per second -- mono 
  237.      or stereo -- play or record) 
  238.    o ALAW: (8 bits per sample -- 11k,22k, or 44k samples per second -- mono or 
  239.      stereo -- play or record) 
  240.    o MULAW: (8 bits per sample -- 11k,22k, or 44k samples per second -- mono or 
  241.      stereo -- play or record) 
  242.  
  243.  MIDI 
  244.  
  245.    o Play 
  246.    o Save 
  247.    o Set the volume 
  248.  
  249.  CD Audio 
  250.  
  251.    o Play 
  252.    o Eject 
  253.    o Lock the Eject button 
  254.    o Set the volume 
  255.    o Stream 
  256.  
  257.  CDXA 
  258.  
  259.    o Play 
  260.    o Eject 
  261.    o Lock the Eject button 
  262.    o Set the volume 
  263.  
  264.  VIDEO 
  265.  
  266.    o Play 
  267.    o Record 
  268.    o Set the volume 
  269.  
  270.  
  271. ΓòÉΓòÉΓòÉ 2.4. The Stop button ΓòÉΓòÉΓòÉ
  272.  
  273. The Stop button allows interruption of testing. This can be helpful if many 
  274. files are highlighted and the Start Test button was pressed by mistake.  It can 
  275. also be used if the first in a series of related test cases fails.  In that 
  276. case, there might be no reason to run the remaining test cases. 
  277.  
  278. The viewing process can be interrupted in the same fashion. 
  279.  
  280.  
  281. ΓòÉΓòÉΓòÉ 2.5. The View Output button ΓòÉΓòÉΓòÉ
  282.  
  283. The View Output button allows the viewing of the *.OUT files that are generated 
  284. from the execution of the *.P2S files. 
  285.  
  286. To view the output for a specified script, highlight the script, and click on 
  287. the VIEW OUTPUT Button. 
  288.  
  289.  
  290. ΓòÉΓòÉΓòÉ 2.6. The DataPath button ΓòÉΓòÉΓòÉ
  291.  
  292. The DataPath button allows the selection of a directory where Datafiles 
  293. necessary for the execution of scripts are located. When the DataPath button is 
  294. pressed, a standard Directory Dialog box is presented.  Any directory on any 
  295. drive can be specified.  Datafiles consist of *.WAV, *.MID, *.AVI, etc. 
  296.  
  297. All the datafiles must exist in the same directory.  If Datafiles are spread 
  298. among more that one directory, it is not possible to test all the scripts at 
  299. once using the DataPath. 
  300.  
  301. Note for Script writers: When AP2 executes P2String, it passes it an 
  302. environment Variable AP2PATH which the script writer will use when specifying a 
  303. datafile.  If the file TEST.WAV is to be used, it would appear as follows: 
  304. ?AP2PATH?TEST.WAV with no spaces between the question mark and the filename. 
  305.  
  306.  
  307. ΓòÉΓòÉΓòÉ 3. Data Structure ΓòÉΓòÉΓòÉ
  308.  
  309. After Installing AP2, the Data Structure would appear as follows: 
  310.  
  311.  AP2\
  312.    SCRIPTS\
  313.    OUT\
  314.  
  315. The AP2 Directory contains all files necessary for execution.  All the P2String 
  316. scripts will be located in the SCRIPTS subdirectory.  All output files that are 
  317. created during the execution of AP2, will be stored in the OUT subdirectory. 
  318.  
  319. If AP2 was installed from the DDK CDROM, the DATA files will be located in the 
  320. following Directory: 
  321.  
  322.       \DDK\TESTX86\TESTCERT\MMEDIA\SYSTEM\AP2\DATA\
  323.  
  324. The DataPath Button should be set to this directory.  This will allow AP2 to 
  325. locate the Datafiles necessary for the successful execution of the P2String 
  326. Scripts. 
  327.  
  328.  
  329. ΓòÉΓòÉΓòÉ 4. Test Case Output ΓòÉΓòÉΓòÉ
  330.  
  331. The P2String output files have the same name as the test cases, but have the 
  332. extension ".OUT".  They are located in the OUT subdirectory. Subsequent 
  333. execution of the same test case will overwrite the old ".OUT" file 
  334.  
  335. Delete unnecessary output files at any time. 
  336.  
  337. RECORD test cases will save wave files in a file called "DELETE.WAV".  Video 
  338. RECORD will save files called "DELETE.AVI".  These files will be overwritten by 
  339. subsequent RECORD test cases.  The "DELETE.WAV" and the "DELETE.AVI" files can 
  340. be erased at any time 
  341.  
  342. Note that a test case that says Error is not necessarily failing.  Test cases 
  343. with the text "FAILED" are not working correctly. 
  344.  
  345.  
  346. ΓòÉΓòÉΓòÉ 5. The Description File ΓòÉΓòÉΓòÉ
  347.  
  348. AP2 Uses a file P2S_DESC.TXT to read in the descriptions for the P2String 
  349. scripts in the SCRIPTS subdirectory.  Each description is to be on only one 
  350. line.  The format for the file is the script filename followed by a ":" 
  351. followed by a description.  If the description is over 256 characters, it will 
  352. be trimmed to 256, or the maximum length available to the Window.  An example 
  353. of a description file follows: 
  354.  
  355. A______1.P2S : Ampmix Test #1
  356. A______2.P2S : Ampmix Test #2
  357.  
  358. If there is no matching description for a test script, the script will be 
  359. shown, but without a description.  If the P2S_DESC.TXT file does not exist, 
  360. there will be no descriptions for the test scripts. 
  361.  
  362.  
  363. ΓòÉΓòÉΓòÉ 6. Error Messages ΓòÉΓòÉΓòÉ
  364.  
  365. The following is a list of all error messages the program generates: 
  366.  
  367. o Help Not Available.  This error message appears if the AP2.HLP file is 
  368.   missing 
  369.  
  370.  
  371. o Help Terminated Due to Error.  This error message appears if the program 
  372.   encounters an error while loading the help file 
  373.  
  374.  
  375. o Unable to create file:  CAPABLTY.TXT.  This error message appears if the 
  376.   program can not create the named file.  This could happen if you were trying 
  377.   to run the program from a read-only medium 
  378.  
  379.  
  380. o Could not find test cases.  This error message appears if no test cases were 
  381.   found in the SCRIPTS subdirectory.  Test cases have a ".P2S" extension 
  382.  
  383.  
  384. o Device driver does not support test cases.  This error message appears if the 
  385.   program determines that none of the available test cases are supported by the 
  386.   device driver 
  387.  
  388.  
  389. o Error Opening AP2.INI, file not found.  This error message appears if the 
  390.   AP2.INI file can not be found in the current directory 
  391.  
  392.  
  393. o Error Reading AP2.INI.  This error message appears if an error occurred while 
  394.   reading from the AP2.INI file.  Restore the AP2.INI file from your original 
  395.   disk. 
  396.  
  397.  
  398. o Error writing AP2.INI.  This error message appears when the program is trying 
  399.   to update the settings for AP2.  This could happen if you were trying to run 
  400.   the program on a read-only medium. 
  401.  
  402.  
  403. o DataPath is Invalid.  Please choose a new one.  This error message appears if 
  404.   the DataPath is invalid.  You will be prompted to select a new DataPath after 
  405.   selecting OK. 
  406.  
  407.  
  408. o No DataPath specified.  Press ENTER to quit AP2.  This error message appears 
  409.   if there was an invalid DataPath, and a valid one was not chosen. 
  410.  
  411.  
  412. o Memory Allocation Error.  You should probably close your apps and shutdown 
  413.   your system when you see this message 
  414.  
  415.  
  416. o Error starting P2STRING.  This error message appears when P2String.EXE can 
  417.   not be found on the path 
  418.  
  419.  
  420. o Error opening file filename.  This error message appears when the program 
  421.   fails to open the named output file 
  422.  
  423.  
  424. o Error reading file filename.  This error message appears when the program 
  425.   fails to read the named output file 
  426.  
  427.  
  428. o Error closing file filename.  This error message appears when the program 
  429.   fails to close the named output file 
  430.  
  431.  
  432. o Error starting the Editor.  This error message appears when the program can 
  433.   not find the standard editor 
  434.  
  435.  
  436. ΓòÉΓòÉΓòÉ 7. P2String ΓòÉΓòÉΓòÉ
  437.  
  438. P2String script processing tool is used to test the mci (media control 
  439. interface) string commands in the MMPM/2 environment. 
  440.  
  441. You can find information on P2String in the .INF file that comes with the 
  442. P2String tool.  For more information on P2String, refer to the  MMPM/2 Device 
  443. Driver Source Kit for OS/2  or the  Multimedia Presentation Manager Toolkit/2 
  444. Subsystem Development Guide  manuals. 
  445.  
  446.  
  447. ΓòÉΓòÉΓòÉ 8. CDXA ΓòÉΓòÉΓòÉ
  448.  
  449. CDXA test cases require path and filename information.  Before running any of 
  450. the test cases for the first time, use an editor to fill-in that information. 
  451. CDXA test cases start with an X and have a .P2S extension. The CDXA test cases 
  452. clearly indicate where to change this information 
  453.  
  454. Please note that CDXA test cases will fail (or not be available) if the audio 
  455. card does not support AVC ADPCM wave audio format